<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>IClient xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/ca/uhn/hl7v2/hoh/api/IClient.html">View Javadoc</a></div><pre>

<a class="jxr_linenumber" name="1" href="#1">1</a>   <strong class="jxr_keyword">package</strong> ca.uhn.hl7v2.hoh.api;
<a class="jxr_linenumber" name="2" href="#2">2</a>   
<a class="jxr_linenumber" name="3" href="#3">3</a>   <strong class="jxr_keyword">import</strong> java.net.Socket;
<a class="jxr_linenumber" name="4" href="#4">4</a>   <strong class="jxr_keyword">import</strong> java.net.URL;
<a class="jxr_linenumber" name="5" href="#5">5</a>   <strong class="jxr_keyword">import</strong> java.nio.charset.Charset;
<a class="jxr_linenumber" name="6" href="#6">6</a>   
<a class="jxr_linenumber" name="7" href="#7">7</a>   <strong class="jxr_keyword">import</strong> ca.uhn.hl7v2.hoh.sign.ISigner;
<a class="jxr_linenumber" name="8" href="#8">8</a>   <strong class="jxr_keyword">import</strong> ca.uhn.hl7v2.hoh.sockets.ISocketFactory;
<a class="jxr_linenumber" name="9" href="#9">9</a>   <strong class="jxr_keyword">import</strong> ca.uhn.hl7v2.hoh.sockets.StandardSocketFactory;
<a class="jxr_linenumber" name="10" href="#10">10</a>  
<a class="jxr_linenumber" name="11" href="#11">11</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../ca/uhn/hl7v2/hoh/api/IClient.html">IClient</a> {
<a class="jxr_linenumber" name="12" href="#12">12</a>  
<a class="jxr_linenumber" name="13" href="#13">13</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="14" href="#14">14</a>  <em class="jxr_javadoccomment">	 * Getter for the host (e.g. "10.0.0.111" or "localhost")</em>
<a class="jxr_linenumber" name="15" href="#15">15</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="16" href="#16">16</a>  	String getHost();
<a class="jxr_linenumber" name="17" href="#17">17</a>  
<a class="jxr_linenumber" name="18" href="#18">18</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="19" href="#19">19</a>  <em class="jxr_javadoccomment">	 * Getter for the port (e.g. 80 for standard HTTP)</em>
<a class="jxr_linenumber" name="20" href="#20">20</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="21" href="#21">21</a>  	<strong class="jxr_keyword">int</strong> getPort();
<a class="jxr_linenumber" name="22" href="#22">22</a>  
<a class="jxr_linenumber" name="23" href="#23">23</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="24" href="#24">24</a>  <em class="jxr_javadoccomment">	 * Returns the socket factory used by this client</em>
<a class="jxr_linenumber" name="25" href="#25">25</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="26" href="#26">26</a>  	ISocketFactory getSocketFactory();
<a class="jxr_linenumber" name="27" href="#27">27</a>  
<a class="jxr_linenumber" name="28" href="#28">28</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="29" href="#29">29</a>  <em class="jxr_javadoccomment">	 * Getter for the "Path" portion of the URL. This is the path portion which</em>
<a class="jxr_linenumber" name="30" href="#30">30</a>  <em class="jxr_javadoccomment">	 * comes after the host and port, so for example if this client is being</em>
<a class="jxr_linenumber" name="31" href="#31">31</a>  <em class="jxr_javadoccomment">	 * used to send messages to</em>
<a class="jxr_linenumber" name="32" href="#32">32</a>  <em class="jxr_javadoccomment">	 * &lt;code&gt;<a href="http://somehost.com:8888/messaging/receiver.jsp&lt;/code&gt;," target="alexandria_uri">http://somehost.com:8888/messaging/receiver.jsp&lt;/code&gt;,</a> the URI</em>
<a class="jxr_linenumber" name="33" href="#33">33</a>  <em class="jxr_javadoccomment">	 * path portion would be &lt;code&gt;/messaging/receiver.jsp&lt;/code&gt;</em>
<a class="jxr_linenumber" name="34" href="#34">34</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="35" href="#35">35</a>  	String getUriPath();
<a class="jxr_linenumber" name="36" href="#36">36</a>  
<a class="jxr_linenumber" name="37" href="#37">37</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="38" href="#38">38</a>  <em class="jxr_javadoccomment">	 * Getter for the URL to send messages to. </em>
<a class="jxr_linenumber" name="39" href="#39">39</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="40" href="#40">40</a>  	URL getUrl();
<a class="jxr_linenumber" name="41" href="#41">41</a>  
<a class="jxr_linenumber" name="42" href="#42">42</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="43" href="#43">43</a>  <em class="jxr_javadoccomment">	 * If set, provides a callback which will be used to se the username and</em>
<a class="jxr_linenumber" name="44" href="#44">44</a>  <em class="jxr_javadoccomment">	 * password associated with the request</em>
<a class="jxr_linenumber" name="45" href="#45">45</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="46" href="#46">46</a>  	<strong class="jxr_keyword">void</strong> setAuthorizationCallback(<a href="../../../../../ca/uhn/hl7v2/hoh/api/IAuthorizationClientCallback.html">IAuthorizationClientCallback</a> theAuthorizationCallback);
<a class="jxr_linenumber" name="47" href="#47">47</a>  
<a class="jxr_linenumber" name="48" href="#48">48</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="49" href="#49">49</a>  <em class="jxr_javadoccomment">	 * &lt;p&gt;</em>
<a class="jxr_linenumber" name="50" href="#50">50</a>  <em class="jxr_javadoccomment">	 * Sets the charset to use for requests from this client. May be changed at</em>
<a class="jxr_linenumber" name="51" href="#51">51</a>  <em class="jxr_javadoccomment">	 * any time.</em>
<a class="jxr_linenumber" name="52" href="#52">52</a>  <em class="jxr_javadoccomment">	 * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="53" href="#53">53</a>  <em class="jxr_javadoccomment">	 * &lt;p&gt;</em>
<a class="jxr_linenumber" name="54" href="#54">54</a>  <em class="jxr_javadoccomment">	 * Default is UTF-8</em>
<a class="jxr_linenumber" name="55" href="#55">55</a>  <em class="jxr_javadoccomment">	 * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="56" href="#56">56</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="57" href="#57">57</a>  	<strong class="jxr_keyword">void</strong> setCharset(Charset theCharset);
<a class="jxr_linenumber" name="58" href="#58">58</a>  
<a class="jxr_linenumber" name="59" href="#59">59</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="60" href="#60">60</a>  <em class="jxr_javadoccomment">	 * Setter for the host (e.g. "10.0.0.111" or "localhost")</em>
<a class="jxr_linenumber" name="61" href="#61">61</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="62" href="#62">62</a>  	<strong class="jxr_keyword">void</strong> setHost(String theHost);
<a class="jxr_linenumber" name="63" href="#63">63</a>  
<a class="jxr_linenumber" name="64" href="#64">64</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="65" href="#65">65</a>  <em class="jxr_javadoccomment">	 * Configures the TCP KeepAlive flag for new connections</em>
<a class="jxr_linenumber" name="66" href="#66">66</a>  <em class="jxr_javadoccomment">	 * </em>
<a class="jxr_linenumber" name="67" href="#67">67</a>  <em class="jxr_javadoccomment">	 * @see Socket#getKeepAlive()</em>
<a class="jxr_linenumber" name="68" href="#68">68</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="69" href="#69">69</a>  	<strong class="jxr_keyword">void</strong> setKeepAlive(<strong class="jxr_keyword">boolean</strong> theKeepAlive);
<a class="jxr_linenumber" name="70" href="#70">70</a>  
<a class="jxr_linenumber" name="71" href="#71">71</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="72" href="#72">72</a>  <em class="jxr_javadoccomment">	 * Returns the TCP KeepAlive flag for new connections</em>
<a class="jxr_linenumber" name="73" href="#73">73</a>  <em class="jxr_javadoccomment">	 * </em>
<a class="jxr_linenumber" name="74" href="#74">74</a>  <em class="jxr_javadoccomment">	 * @see Socket#getKeepAlive()</em>
<a class="jxr_linenumber" name="75" href="#75">75</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="76" href="#76">76</a>  	<strong class="jxr_keyword">boolean</strong> isKeepAlive();
<a class="jxr_linenumber" name="77" href="#77">77</a>  
<a class="jxr_linenumber" name="78" href="#78">78</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="79" href="#79">79</a>  <em class="jxr_javadoccomment">	 * Sets the TCP SO Timeout setting for new connections</em>
<a class="jxr_linenumber" name="80" href="#80">80</a>  <em class="jxr_javadoccomment">	 * </em>
<a class="jxr_linenumber" name="81" href="#81">81</a>  <em class="jxr_javadoccomment">	 * @see Socket#getSoTimeout()</em>
<a class="jxr_linenumber" name="82" href="#82">82</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="83" href="#83">83</a>  	<strong class="jxr_keyword">void</strong> setSoTimeout(<strong class="jxr_keyword">int</strong> theSoTimeout);
<a class="jxr_linenumber" name="84" href="#84">84</a>  
<a class="jxr_linenumber" name="85" href="#85">85</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="86" href="#86">86</a>  <em class="jxr_javadoccomment">	 * Returns the TCP SO Timeout setting for new connections</em>
<a class="jxr_linenumber" name="87" href="#87">87</a>  <em class="jxr_javadoccomment">	 * </em>
<a class="jxr_linenumber" name="88" href="#88">88</a>  <em class="jxr_javadoccomment">	 * @see Socket#getSoTimeout()</em>
<a class="jxr_linenumber" name="89" href="#89">89</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="90" href="#90">90</a>  	<strong class="jxr_keyword">int</strong> getSoTimeout();
<a class="jxr_linenumber" name="91" href="#91">91</a>  
<a class="jxr_linenumber" name="92" href="#92">92</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="93" href="#93">93</a>  <em class="jxr_javadoccomment">	 * Setter for the "Path" portion of the URL. This is the path portion which</em>
<a class="jxr_linenumber" name="94" href="#94">94</a>  <em class="jxr_javadoccomment">	 * comes after the host and port, so for example if this client is being</em>
<a class="jxr_linenumber" name="95" href="#95">95</a>  <em class="jxr_javadoccomment">	 * used to send messages to</em>
<a class="jxr_linenumber" name="96" href="#96">96</a>  <em class="jxr_javadoccomment">	 * &lt;code&gt;<a href="http://somehost.com:8888/messaging/receiver.jsp&lt;/code&gt;," target="alexandria_uri">http://somehost.com:8888/messaging/receiver.jsp&lt;/code&gt;,</a> the URI</em>
<a class="jxr_linenumber" name="97" href="#97">97</a>  <em class="jxr_javadoccomment">	 * path portion would be &lt;code&gt;/messaging/receiver.jsp&lt;/code&gt;</em>
<a class="jxr_linenumber" name="98" href="#98">98</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="99" href="#99">99</a>  	<strong class="jxr_keyword">void</strong> setUriPath(String thePath);
<a class="jxr_linenumber" name="100" href="#100">100</a> 
<a class="jxr_linenumber" name="101" href="#101">101</a> 	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="102" href="#102">102</a> <em class="jxr_javadoccomment">	 * Getter for the port (e.g. 80 for standard HTTP)</em>
<a class="jxr_linenumber" name="103" href="#103">103</a> <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="104" href="#104">104</a> 	<strong class="jxr_keyword">void</strong> setPort(<strong class="jxr_keyword">int</strong> thePort);
<a class="jxr_linenumber" name="105" href="#105">105</a> 
<a class="jxr_linenumber" name="106" href="#106">106</a> 	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="107" href="#107">107</a> <em class="jxr_javadoccomment">	 * Sets the number of milliseconds before timing out. Default is</em>
<a class="jxr_linenumber" name="108" href="#108">108</a> <em class="jxr_javadoccomment">	 * {@link #DEFAULT_RESPONSE_TIMEOUT}</em>
<a class="jxr_linenumber" name="109" href="#109">109</a> <em class="jxr_javadoccomment">	 * </em>
<a class="jxr_linenumber" name="110" href="#110">110</a> <em class="jxr_javadoccomment">	 * @param theResponseTimeout</em>
<a class="jxr_linenumber" name="111" href="#111">111</a> <em class="jxr_javadoccomment">	 *            The millis to wait before timeout.</em>
<a class="jxr_linenumber" name="112" href="#112">112</a> <em class="jxr_javadoccomment">	 * @see #DEFAULT_RESPONSE_TIMEOUT</em>
<a class="jxr_linenumber" name="113" href="#113">113</a> <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="114" href="#114">114</a> 	<strong class="jxr_keyword">void</strong> setResponseTimeout(<strong class="jxr_keyword">long</strong> theResponseTimeout);
<a class="jxr_linenumber" name="115" href="#115">115</a> 
<a class="jxr_linenumber" name="116" href="#116">116</a> 	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="117" href="#117">117</a> <em class="jxr_javadoccomment">	 * @param theSigner</em>
<a class="jxr_linenumber" name="118" href="#118">118</a> <em class="jxr_javadoccomment">	 *            If provided, sets the Signature Profile signer implementation</em>
<a class="jxr_linenumber" name="119" href="#119">119</a> <em class="jxr_javadoccomment">	 *            to use. See &lt;a href=</em>
<a class="jxr_linenumber" name="120" href="#120">120</a> <em class="jxr_javadoccomment">	 *            "<a href="http://hl7api.sourceforge.net/hapi-hl7overhttp/specification.html" target="alexandria_uri">http://hl7api.sourceforge.net/hapi-hl7overhttp/specification.html</a>#SIGNATURE_PROFILE"</em>
<a class="jxr_linenumber" name="121" href="#121">121</a> <em class="jxr_javadoccomment">	 *            &gt;<a href="http://hl7api.sourceforge.net/hapi-hl7overhttp/specification." target="alexandria_uri">http://hl7api.sourceforge.net/hapi-hl7overhttp/specification.</a></em>
<a class="jxr_linenumber" name="122" href="#122">122</a> <em class="jxr_javadoccomment">	 *            html#SIGNATURE_PROFILE&lt;/a&gt;</em>
<a class="jxr_linenumber" name="123" href="#123">123</a> <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="124" href="#124">124</a> 	<strong class="jxr_keyword">void</strong> setSigner(<a href="../../../../../ca/uhn/hl7v2/hoh/sign/ISigner.html">ISigner</a> theSigner);
<a class="jxr_linenumber" name="125" href="#125">125</a> 
<a class="jxr_linenumber" name="126" href="#126">126</a> 	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="127" href="#127">127</a> <em class="jxr_javadoccomment">	 * Sets the socket factory used by this client. Default is</em>
<a class="jxr_linenumber" name="128" href="#128">128</a> <em class="jxr_javadoccomment">	 * {@link StandardSocketFactory}.</em>
<a class="jxr_linenumber" name="129" href="#129">129</a> <em class="jxr_javadoccomment">	 * </em>
<a class="jxr_linenumber" name="130" href="#130">130</a> <em class="jxr_javadoccomment">	 * @see ISocketFactory</em>
<a class="jxr_linenumber" name="131" href="#131">131</a> <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="132" href="#132">132</a> 	<strong class="jxr_keyword">void</strong> setSocketFactory(<a href="../../../../../ca/uhn/hl7v2/hoh/sockets/ISocketFactory.html">ISocketFactory</a> theSocketFactory);
<a class="jxr_linenumber" name="133" href="#133">133</a> 
<a class="jxr_linenumber" name="134" href="#134">134</a> 	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="135" href="#135">135</a> <em class="jxr_javadoccomment">	 * Setter for the URL to send messages to. </em>
<a class="jxr_linenumber" name="136" href="#136">136</a> <em class="jxr_javadoccomment">	 * Note that invoking this method replaces any values that have been </em>
<a class="jxr_linenumber" name="137" href="#137">137</a> <em class="jxr_javadoccomment">	 * provided to {@link #setHost(String)}, {@link #setPort(int)}, or {@link #setUriPath(String)}</em>
<a class="jxr_linenumber" name="138" href="#138">138</a> <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="139" href="#139">139</a> 	<strong class="jxr_keyword">void</strong> setUrl(URL theUrl);
<a class="jxr_linenumber" name="140" href="#140">140</a> 
<a class="jxr_linenumber" name="141" href="#141">141</a> 	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="142" href="#142">142</a> <em class="jxr_javadoccomment">	 * Setter for the URL to send messages to. </em>
<a class="jxr_linenumber" name="143" href="#143">143</a> <em class="jxr_javadoccomment">	 * Note that invoking this method replaces any values that have been </em>
<a class="jxr_linenumber" name="144" href="#144">144</a> <em class="jxr_javadoccomment">	 * provided to {@link #setHost(String)}, {@link #setPort(int)}, or {@link #setUriPath(String)}</em>
<a class="jxr_linenumber" name="145" href="#145">145</a> <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="146" href="#146">146</a> 	<strong class="jxr_keyword">void</strong> setUrlString(String theString);
<a class="jxr_linenumber" name="147" href="#147">147</a> 
<a class="jxr_linenumber" name="148" href="#148">148</a> 	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="149" href="#149">149</a> <em class="jxr_javadoccomment">	 * Getter for the URL to send messages to. </em>
<a class="jxr_linenumber" name="150" href="#150">150</a> <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="151" href="#151">151</a> 	String getUrlString();
<a class="jxr_linenumber" name="152" href="#152">152</a> 
<a class="jxr_linenumber" name="153" href="#153">153</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div><script type="text/javascript">
                var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
                document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
                </script>
                <script type="text/javascript">
                try {
                var pageTracker = _gat._getTracker("UA-1395874-4");
                pageTracker._trackPageview();
                } catch(err) {}</script>
                </body >
</html>

